YNQ  YNQ-1.5.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups
Special Operations

Modules

 Authentication Level
 

Functions

NQ_BOOL ccGetSigningPolicy (void)
 
void ccSetSigningPolicy (NQ_BOOL enable)
 
NQ_STATUS ccSetMinSecurityLevel (NQ_INT level)
 
NQ_INT ccGetMinSecurityLevel (void)
 
NQ_STATUS ccSetMaxSecurityLevel (NQ_INT level)
 
NQ_INT ccGetMaxSecurityLevel (void)
 
NQ_BOOL ccSetExclusiveAccessToFileA (NQ_CHAR *fileName, NQ_BOOL makeExclusive)
 
NQ_BOOL ccSetExclusiveAccessToFile (NQ_WCHAR *fileName, NQ_BOOL makeExclusive)
 
NQ_BOOL ccIsExclusiveAccessToFileA (NQ_CHAR *fileName)
 
NQ_BOOL ccIsExclusiveAccessToFile (NQ_WCHAR *fileName)
 

Detailed Description

Function Documentation

NQ_BOOL ccGetSigningPolicy ( void  )

This function is called by application to get the current Message Signing mode.

Returns
TRUE if Message Signing is enabled and FALSE otherwise
void ccSetSigningPolicy ( NQ_BOOL  enable)

This function is called by application to set the current Message Signing mode.

Parameters
enableIf set to TRUE NQ Client will sign messages. if set to FALSE NQ Client will not sign messages.
Note
Default is TRUE. It's not recommended to set to FALSE unless the server shows unusual behavior.
NQ_STATUS ccSetMinSecurityLevel ( NQ_INT  level)

This function is called by application to set the NQ CIFS Client security minimal level. Before this function is called NQ CIFS Client uses the default security configuration (see AM_MAXSECURITYLEVEL in NQ Library Reference - Authentication)

Parameters
levelLAN Manager authentication level. The value of this parameter corresponds to table see amClientDefineLevel in NQ Library Reference - Authentication
Returns
NQ_SUCCESS or NQ_FAIL when level requested is invalid.
NQ_INT ccGetMinSecurityLevel ( void  )

This function is called by application to get the NQ CIFS Client security minimal level.

Returns
Current NQ CIFS Client security minimal level. Value returned corresponds to table see amClientDefineLevel in NQ Library Reference - Authentication
NQ_STATUS ccSetMaxSecurityLevel ( NQ_INT  level)

This function is called by application to set the NQ CIFS Client security maximal level. Before this function is called NQ CIFS Client uses the default security configuration (see AM_MAXSECURITYLEVEL in NQ Library Reference - Authentication)

Parameters
levelLAN Manager authentication level. The value of this parameter corresponds to table see amClientDefineLevel in NQ Library Reference - Authentication
Returns
NQ_SUCCESS or NQ_FAIL when level requested is invalid.
NQ_INT ccGetMaxSecurityLevel ( void  )

This function is called by application to get the NQ CIFS Client security maximal level.

Returns
Current NQ CIFS Client security maximal level. Value returned corresponds to table see amClientDefineLevel in NQ Library Reference - Authentication
NQ_BOOL ccSetExclusiveAccessToFileA ( NQ_CHAR fileName,
NQ_BOOL  makeExclusive 
)

This function sets or removes exclusive access rights or restores default access rights.

This function applies access rights to a file. When makeExclusive parameter is TRUE the following access rights will be applied:

  • Owner - full access
  • Administrators (group) - full access
  • All others - no access
  • When applied to a folder, access rights will be propagated down to subfolders/files, unless they have non-inheriting security descriptors
  • The ownership is changed to the user authenticated.
  • Access rights of the parent directory will be no more inherited. When the second parameter is FALSE file descriptor is modified so that all access rights are inherited from the parent directory.

When this function returns TRUE it means that the remote server has accepted new access rights but it does not guarantee that those rights were effectively modified. To check the latter use ccIsExclusiveAccessToFile().

Parameters
fileNamePath to the file.
makeExclusiveTRUE to set exclusive access, FALSE to revert to default access rights.
Returns
TRUE when operation succeeded, FALSE on error. The application can inspect the error code for the failure reason.
Note
This is an ASCII version of ccSetExclusiveAccessToFile()
NQ_BOOL ccSetExclusiveAccessToFile ( NQ_WCHAR fileName,
NQ_BOOL  makeExclusive 
)

This function sets or removes exclusive access rights or restores default access rights.

This function applies access rights to a file. When makeExclusive parameter is TRUE the following access rights will be applied:

  • Owner - full access
  • Administrators (group) - full access
  • All others - no access
  • When applied to a folder, access rights will be propagated down to subfolders/files, unless they have non-inheriting security descriptors
  • The ownership is changed to the user authenticated.
  • Access rights of the parent directory will be no more inherited. When the second parameter is FALSE file descriptor is modified so that all access rights are inherited from the parent directory.

When this function returns TRUE it means that the remote server has accepted new access rights but it does not guarantee that those rights were effectively modified. To check the latter use ccIsExclusiveAccessToFile().

Parameters
fileNamePath to the file.
makeExclusiveTRUE to set exclusive access, FALSE to revert to default access rights.
Returns
TRUE when operation succeeded, FALSE on error. The application can inspect the error code for the failure reason.
NQ_BOOL ccIsExclusiveAccessToFileA ( NQ_CHAR fileName)

This function is called by application to determine whether the file/directory specified by the parameter has exclusive access rights.

Parameters
fileNamePath to the file.
Returns
TRUE if the file specified by the parameter has exclusive access rights or FALSE otherwise.
See Also

ccSetExclusiveAccessToFile()

Note
This is an ASCII version of ccIsExclusiveAccessToFile()
NQ_BOOL ccIsExclusiveAccessToFile ( NQ_WCHAR fileName)

This function is called by application to determine whether the file/directory specified by the parameter has exclusive access rights.

Parameters
fileNamePath to the file.
Returns
TRUE if the file specified by the parameter has exclusive access rights or FALSE otherwise.
See Also
ccSetExclusiveAccessToFile()